/*
 * Copyright (c) 2011-2023 Contributors to the Eclipse Foundation
 *
 * This program and the accompanying materials are made available under the
 * terms of the Eclipse Public License 2.0 which is available at
 * http://www.eclipse.org/legal/epl-2.0, or the Apache License, Version 2.0
 * which is available at https://www.apache.org/licenses/LICENSE-2.0.
 *
 * SPDX-License-Identifier: EPL-2.0 OR Apache-2.0
 */
package io.vertx.core.spi.resolver.endpoint;

import io.vertx.core.Future;
import io.vertx.core.impl.ContextInternal;
import io.vertx.core.net.Address;

/**
 *  A resolver for endpoints.
 *
 * @author <a href="mailto:julien@julienviet.com">Julien Viet</a>
 */
public interface EndpointResolver<A extends Address> {

  /**
   * Check whether the resolver accepts the {@code Address} and returns the cast address.
   *
   * @param address the addrss to check
   * @return the cast address
   */
  A accepts(Address address);

  /**
   * Lookup an endpoint for the specified {@code address}
   * @param ctx the vertx context
   * @param address the address to lookup
   * @return the endpoint lookup result
   */
  Future<EndpointLookup> lookupEndpoint(ContextInternal ctx, A address);

  /**
   * Check expired endpoints, this method is called by the client periodically to give the opportunity to trigger eviction
   * or refreshes.
   */
  void checkExpired();

}
